Skip to content

Overview page sdk#853

Open
BaptisteGi wants to merge 4 commits intostablefrom
bgi-overview-page
Open

Overview page sdk#853
BaptisteGi wants to merge 4 commits intostablefrom
bgi-overview-page

Conversation

@BaptisteGi
Copy link
Copy Markdown
Contributor

@BaptisteGi BaptisteGi commented Feb 25, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced Python SDK introduction with clearer overview and expanded guidance.
    • Added code examples (async and sync) for quick reference.
    • Included installation instructions for multiple package managers.
    • Added comparison guide for using the SDK versus direct API calls.
    • Improved navigation with structured next steps and related guides.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 25, 2026

Walkthrough

This pull request rewrites the Python SDK introduction MDX: the front-matter title is changed to "Python SDK overview", MDX imports are updated to use Docusaurus theme components (Tabs, TabItem) and ReferenceLink, and the VideoPlayer import path is adjusted. The page body replaces earlier sections with new structured content (overview, "What you can do with it", "A quick look" async/sync tabs, SDK vs API comparison, key capabilities, installation tabs, and next steps). Additionally, .vale/styles/spelling-exceptions.txt adds the word walkthrough.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request has no description provided, making it impossible to assess the rationale, changes, testing, or impact of the modifications. Add a comprehensive pull request description following the template, including sections for Why, What changed, How to review, and Impact & rollout to clarify the purpose and scope of documentation updates.
Title check ❓ Inconclusive The title 'Overview page sdk' is vague and lacks clarity. It doesn't clearly specify what aspect of the SDK overview is being changed or improved. Consider a more descriptive title such as 'Restructure Python SDK introduction with use cases and examples' or 'Add comprehensive SDK overview section with examples and comparison table' to better convey the main changes.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Feb 25, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Feb 25, 2026

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ac5e73
Status: ✅  Deploy successful!
Preview URL: https://43f51ec9.infrahub-sdk-python.pages.dev
Branch Preview URL: https://bgi-overview-page.infrahub-sdk-python.pages.dev

View logs

@BaptisteGi BaptisteGi marked this pull request as ready for review March 30, 2026 14:56
@BaptisteGi BaptisteGi self-assigned this Mar 30, 2026
@BaptisteGi BaptisteGi requested a review from wvandeun March 30, 2026 15:12
@BaptisteGi BaptisteGi changed the title Draft overview page sdk Overview page sdk Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant